Skip to content

Point to check from the top of the README - #113

Merged
arvida merged 2 commits into
mainfrom
docs/readme-check
Oct 2, 2026
Merged

arvida merged 2 commits into
mainfrom
docs/readme-check

Conversation

@arvida

@arvida arvida commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

The README already documents check in full under Commands (### Check, added with #85/#87). That section sits below the paid quick start, init, login and translate, so someone arriving from a list or an npm search sees the account-only flow first.

This adds one line after Quick start pointing to it:

No account yet? npx @localheroai/cli check finds missing keys, broken placeholders and missing plural forms in your locale files, free and offline. See Check.

An earlier revision of this PR added a second Check section on the mistaken belief that the README had none; that is reverted, so the net diff is the two lines above.

arvida added 2 commits October 2, 2026 15:09
- The README never mentioned check, the one command that needs no account; it is also the npm package page
- Adds a short section after Quick start and an entry under Commands, with each claim checked against the code
- The README already documents check under Commands (added with #85/#87); the earlier commit duplicated it
- Keep only a one-line pointer after Quick start, since that section sits below the paid setup steps
@arvida arvida changed the title Show check in the README Point to check from the top of the README Oct 2, 2026
@arvida arvida mentioned this pull request Oct 2, 2026
@arvida
arvida merged commit d10b1e5 into main Oct 2, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant